home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / idl / nsIDOMSerializer.idl < prev    next >
Text File  |  2006-05-08  |  3KB  |  85 lines
  1. /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
  2. /* ***** BEGIN LICENSE BLOCK *****
  3.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  4.  *
  5.  * The contents of this file are subject to the Mozilla Public License Version
  6.  * 1.1 (the "License"); you may not use this file except in compliance with
  7.  * the License. You may obtain a copy of the License at
  8.  * http://www.mozilla.org/MPL/
  9.  *
  10.  * Software distributed under the License is distributed on an "AS IS" basis,
  11.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12.  * for the specific language governing rights and limitations under the
  13.  * License.
  14.  *
  15.  * The Original Code is mozilla.org code.
  16.  *
  17.  * The Initial Developer of the Original Code is
  18.  * Netscape Communications Corporation.
  19.  * Portions created by the Initial Developer are Copyright (C) 1998
  20.  * the Initial Developer. All Rights Reserved.
  21.  *
  22.  * Contributor(s):
  23.  *
  24.  * Alternatively, the contents of this file may be used under the terms of
  25.  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26.  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27.  * in which case the provisions of the GPL or the LGPL are applicable instead
  28.  * of those above. If you wish to allow use of your version of this file only
  29.  * under the terms of either the GPL or the LGPL, and not to allow others to
  30.  * use your version of this file under the terms of the MPL, indicate your
  31.  * decision by deleting the provisions above and replace them with the notice
  32.  * and other provisions required by the GPL or the LGPL. If you do not delete
  33.  * the provisions above, a recipient may use your version of this file under
  34.  * the terms of any one of the MPL, the GPL or the LGPL.
  35.  *
  36.  * ***** END LICENSE BLOCK ***** */
  37.  
  38. #include "nsISupports.idl"
  39.  
  40. interface nsIOutputStream;
  41. interface nsIDOMNode;
  42.  
  43. /**
  44.  * The nsIDOMSerializer interface is really a placeholder till the W3C
  45.  * DOM Working Group defines a mechanism for serializing DOM nodes.
  46.  * An instance of this interface can be used to serialize a DOM document
  47.  * or any DOM subtree.
  48.  */
  49.  
  50. [scriptable, uuid(9fd4ba15-e67c-4c98-b52c-7715f62c9196)]
  51. interface nsIDOMSerializer : nsISupports
  52. {
  53.   /**
  54.    * The subtree rooted by the specified element is serialized to
  55.    * a string.
  56.    * 
  57.    * @param root The root of the subtree to be serialized. This could
  58.    *             be any node, including a Document.
  59.    * @returns The serialized subtree in the form of a Unicode string
  60.    */
  61.   AString serializeToString(in nsIDOMNode root);
  62.  
  63.   /**
  64.    * The subtree rooted by the specified element is serialized to
  65.    * a byte stream using the character set specified.
  66.    * @param root The root of the subtree to be serialized. This could
  67.    *             be any node, including a Document.
  68.    * @param stream The byte stream to which the subtree is serialized.
  69.    * @param charset The name of the character set to use for the encoding
  70.    *                to a byte stream.
  71.    */
  72.   void serializeToStream(in nsIDOMNode root, in nsIOutputStream stream,
  73.                          in AUTF8String charset);
  74. };
  75.  
  76. %{ C++
  77. #define NS_XMLSERIALIZER_CID                        \
  78.  { /* a6cf9124-15b3-11d2-932e-00805f8add32 */       \
  79.    0xa6cf9124, 0x15b3, 0x11d2,                      \
  80.   {0x93, 0x2e, 0x00, 0x80, 0x5f, 0x8a, 0xdd, 0x32} }
  81. #define NS_XMLSERIALIZER_CONTRACTID \
  82. "@mozilla.org/xmlextras/xmlserializer;1"
  83. %}
  84.  
  85.